Publish Markdown and llms.txt docs with ExDoc 0.40.3 - #244
Open
BobbieBarker wants to merge 2 commits into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Important
This PR is stacked on #243, which makes the required Elixir 1.15 compatibility change explicit. Please review and merge #243 first; once it lands, this PR's effective diff is only the ExDoc dependency and lockfile update.
Summary
llms.txtWhy this matters
ExDoc v0.40 added native Markdown output and
llms.txtgeneration. Publishing those artifacts on HexDocs makes Decimal's documentation directly consumable by modern documentation retrieval tools, including docs-mcp-server, without scraping the HTML site. Broad library adoption is what makes this useful across the Elixir ecosystem.After this merges, please publish or re-publish Decimal's documentation at your earliest convenience so the Markdown pages and
llms.txtbecome available to the community.Compatibility
ExDoc remains a development-only dependency and does not become part of Decimal's runtime dependency graph. The ExDoc release itself requires Elixir 1.15, which is why the runtime compatibility decision is isolated in #243.
Verification
MIX_ENV=dev mix docsgenerated HTML and EPUB, with nollms.txtor Markdown pagesMIX_ENV=dev mix docsgenerated HTML, EPUB,llms.txt, and 5 Markdown filesllms.txtresolve to generated filesmix format --check-formatted mix.exsMIX_ENV=test mix deps.unlock --check-unusedMIX_ENV=test mix compile --warnings-as-errorsMIX_ENV=test mix test— 266 passed (105 doctests, 36 properties, 125 tests)